home *** CD-ROM | disk | FTP | other *** search
/ MacHack 1997 / MacHack 1997.toast / Hacks / Hacks ’96 / Audio dcmds / Audio CD dcmds.sit / Audio CD dcmds.π / for think folder / THINK dcmds / Dcmd.h next >
Text File  |  1994-07-26  |  6KB  |  151 lines
  1. /*    dcmd.h
  2.     This is the dcmd interface.
  3.     Copyright © 1988 Apple Computer, Inc.  All rights reserved.
  4. */
  5.  
  6. #ifndef __dcmd__
  7. #define __dcmd__
  8.  
  9.  
  10. // Possible requests from the debugger to the command
  11. #define dcmdInit 0
  12. #define dcmdDoIt 1
  13. #define dcmdHelp 2
  14.  
  15.  
  16. // Register file indices
  17. #define D0Register 0
  18. #define D1Register 1
  19. #define D2Register 2
  20. #define D3Register 3
  21. #define D4Register 4
  22. #define D5Register 5
  23. #define D6Register 6
  24. #define D7Register 7
  25.  
  26. #define A0Register 8
  27. #define A1Register 9
  28. #define A2Register 10
  29. #define A3Register 11
  30. #define A4Register 12
  31. #define A5Register 13
  32. #define A6Register 14
  33. #define A7Register 15
  34.  
  35. #define PCRegister 16
  36. #define SRRegister 17        // SR is only 16 bits and is stored in the high word
  37.  
  38.  
  39. // Heap block types
  40. #define freeBlock             0
  41. #define nonrelocatableBlock 1
  42. #define relocatableBlock    2
  43.  
  44.  
  45. typedef struct
  46.     {
  47.     long* registerFile;
  48.     short request;
  49.     Boolean aborted;        // Set to true if the user types a key while scrolling
  50.     } dcmdBlock;
  51.  
  52. // EJECT
  53.  
  54. // Debugger routines that can be called by the command
  55.  
  56.   /* Draw the text in the Pascal string as one or more lines separated by CR's.
  57.      Each line causes the MacsBug display to be scrolled and the new line to be
  58.      drawn at the bottom. If the user types a key while scrolling then the aborted
  59.      flag is set telling the command to terminate immediately. */
  60.   pascal void dcmdDrawLine(const Str255 str);
  61.  
  62.   /* Draw the text in the Pascal string as a continuation of the current line.
  63.        CR's are not given special treatment. */
  64.   pascal void dcmdDrawString(const Str255 str);
  65.  
  66.   /* Draw a given number of characters starting from the given pointer as a 
  67.        continuation of the current line. CR's are not given special treatment. */
  68.   pascal void dcmdDrawText(StringPtr text, short length);
  69.  
  70.   /* Scrolls the MacsBug display up one line leaving a blank line at the bottom. */
  71.   pascal void dcmdScroll();
  72.  
  73.   /* Display the Pascal string in the command line area and wait for a key to be pressed.
  74.      Return TRUE if the user typed Return. All other keys return FALSE. MacsBug saves this
  75.      key and adds it to the command line once the current command completes. Typing any
  76.      key other than Return sets the aborted flag and tells the command to terminate immediately. */
  77.   pascal Boolean dcmdDrawPrompt(const Str255 str);
  78.  
  79.   /* Get the current command line position */
  80.   pascal short dcmdGetPosition();
  81.         
  82.   /* Set the current command line position. This should only be set to a value returned 
  83.      by dcmdGetPosition. */
  84.   pascal void dcmdSetPosition(short pos);
  85.  
  86.   /* Return the next character on the command line or CR if the entire line has been scanned */
  87.   pascal short dcmdGetNextChar();
  88.         
  89.   /* Return the next character on the command line or CR if the entire line has been scanned.
  90.      However, the current command line position is not changed. */
  91.   pascal short dcmdPeekAtNextChar();
  92.  
  93.   /* Copy all characters from the command line to the parameter string until a delimiter
  94.      is found or the end of the command line is reached. A delimiter is either a space,
  95.      a comma or a CR. Both single and double quoted strings are allowed on the command
  96.      line. However, the leading and trailing quotes must be of the same type. The parameter
  97.      string is returned without the quotes. This function returns the delimiter */
  98.   pascal short dcmdGetNextParameter(Str255 str);
  99.  
  100.   /* Parse the command line for the next expression. All expressions are evaluated to 32 bits.
  101.      This function returns the delimiter after the expression. The possible delimiters are
  102.      space, comma and CR.  Space is    not treated as a delimiter in the middle of expressions.
  103.      For instance, '1 + 2' will return    a value of 3 and the delimiter will be the char following
  104.      the 2. The return parameter 'ok' tells if the expression was parsed successfully. */
  105.   pascal short dcmdGetNextExpression(long* value, Boolean* ok);
  106.  
  107.   /* Copy the break message MacsBug displayed the last time it was entered into str.
  108.      This may contain multiple lines separated by CR's.*/
  109.   pascal void dcmdGetBreakMessage(Str255 str);
  110.         
  111.   /* Return a symbolic representation for address in str. If no symbol can be found
  112.      then an empty string is returned. The format of the symbol returned is Name+0000.
  113.      With the new compilers, the name is no longer restricted to 8 characters. */
  114.   pascal void dcmdGetNameAndOffset(long address, Str255 str);
  115.  
  116.   /* Return the trap name for the trap number. If no symbol can be found
  117.      then an empty string is returned. */
  118.   pascal void dcmdGetTrapName(short trapNumber, Str255 trapName);
  119.  
  120.   /* Return a pointer the macro name for the given value. If no macro can be found
  121.      then a nil is returned. */
  122.   pascal StringPtr dcmdGetMacroName(long value);
  123.  
  124.   /* When a debugger command is called, the debugger's world (low memory) is installed.
  125.      Commands that want to reference the user's world can swap back and forth between the
  126.      two worlds by making this call. This procedure does nothing in MacsBug. It is included
  127.      to support other debuggers that might want to take advantage of it. */
  128.   pascal void dcmdSwapWorlds();
  129.  
  130.   /* Toggle between the user and debugger displays.
  131.      The first call restores the user's actual screen.
  132.      The second call restores the debugger's screen. */
  133.   pascal void dcmdSwapScreens();
  134.  
  135.   /* Walk thru the blocks in the current heap, calling DoThis for each block. DoThis should
  136.      be a procedure of the form:
  137.                 
  138.         pascal void DoThis (long blockAddress, long blockLength, long addrOfMasterPtr,
  139.                              short blockType, Boolean locked, Boolean purgeable, Boolean resource)
  140.  
  141.      The blockAddress and blockLength pertain to the data in the heap block, not including
  142.      the block header. The addrOfMasterPtr is the master pointer's location in the heap,
  143.      not the value of the master ptr. The blockType is defined by the constants freeBlock,
  144.      nonrelocatableBlock and relocatableBlock. The booleans locked, purgeable and resource
  145.      reflect the state of the block.    */
  146.   typedef pascal void (*DoThisPtr) (long blockAddress, long blockLength, long addrOfMasterPtr,
  147.                                      short blockType, Boolean locked, Boolean purgeable, Boolean resource);
  148.   pascal void dcmdForAllHeapBlocks (DoThisPtr DoThis);
  149.  
  150. #endif
  151.